package org.emet.jee.core.servlet;

import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.net.URLConnection;
import java.util.HashMap;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang.StringUtils;
import org.emet.jee.core.EmetContext;

/**
 * 处理资源文件，将类路径的资源文件映射到网站路径下
 * 
 */
public class ResourceManager extends HttpServlet {

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	private static String etag;

	private static final String HEADER_ETAG = "ETag";

	private static final String HEADER_IF_MODIFIED = "If-Modified-Since";

	private static final String HEADER_IF_NONE = "If-None-Match";

	private static final String HEADER_LAST_MODIFIED = "Last-Modified";

	private static final HashMap<String, String> mimeTypes = new HashMap<String, String>();

	private static long servletContainerStartTime;
	static {
		long now = System.currentTimeMillis();
		ResourceManager.servletContainerStartTime = now - (now % 1000);

		ResourceManager.etag = "\"" + ResourceManager.servletContainerStartTime + '\"';
	}

	public static void copyStreams(final InputStream input, final OutputStream output, final int bufferSize)
			throws IOException {
		int n = 0;
		final byte[] buffer = new byte[bufferSize];
		while (-1 != (n = input.read(buffer))) {
			output.write(buffer, 0, n);
		}
	}

	/**
	 * 是否忽略最后一次修改,正式运行时应为false
	 */
	private static boolean ignoreLastModified = !EmetContext.getBoolProperty("userResourceBuffer", true);

	public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		if (isUpToDate(request)) {
			response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
			return;
		}

		BufferedInputStream bis = null;
		BufferedOutputStream bos = null;

		try {
			String theServletPath = request.getServletPath() + request.getPathInfo();

			String theExtension = StringUtils.right(theServletPath,
					theServletPath.length() - theServletPath.lastIndexOf(".") - 1);

			URL resource = ResourceManager.class.getResource(theServletPath);

			final String mimeType = (String) ResourceManager.mimeTypes.get(theExtension.trim().toLowerCase());
			if ((resource != null) && (mimeType != null)) {
				URLConnection urlConnection = resource.openConnection();
				int length = urlConnection.getContentLength();

				response.setContentType(mimeType);
				response.setContentLength(length);
				if (!ResourceManager.ignoreLastModified) {
					response.setDateHeader(ResourceManager.HEADER_LAST_MODIFIED,
							ResourceManager.servletContainerStartTime);
					response.setHeader(ResourceManager.HEADER_ETAG, ResourceManager.etag);
				}

				bis = new BufferedInputStream(urlConnection.getInputStream());
				bos = new BufferedOutputStream(response.getOutputStream());

				ResourceManager.copyStreams(bis, bos, 4096);
			} else {
				response.sendError(404);
			}
		} finally {
			if (bis != null) {
				try {
					//由于前台人为关闭浏览器而导致Socket错误,故加此异常处理
					bis.close();
				} catch (IOException ignore) {
				}
			}
			if (bos != null) {
				try {
					//由于前台人为关闭浏览器而导致Socket错误,故加此异常处理
					bos.flush();
					bos.close();
				} catch (IOException ignore) {
				}
			}

		}
	}

	public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		doGet(request, response);
	}

	public void init() throws ServletException {

		ResourceManager.mimeTypes.put("js", "text/javascript");
		ResourceManager.mimeTypes.put("css", "text/css");
		ResourceManager.mimeTypes.put("gif", "image/gif");
		ResourceManager.mimeTypes.put("jpg", "image/jpeg");
		ResourceManager.mimeTypes.put("jpeg", "image/jpeg");
		ResourceManager.mimeTypes.put("jpe", "image/jpeg");
		ResourceManager.mimeTypes.put("png", "image/png");
		ResourceManager.mimeTypes.put("html", "text");
		ResourceManager.mimeTypes.put("jar", "application/java-archive");
		ResourceManager.mimeTypes.put("htc", "text/x-component");
		ResourceManager.mimeTypes.put("swf", "application/x-shockwave-flash");
		ResourceManager.mimeTypes.put("svg", "image/svg+xml");

	}

	private boolean isUpToDate(HttpServletRequest req) {
		if (ResourceManager.ignoreLastModified) {
			return false;
		}

		long modifiedSince = req.getDateHeader(ResourceManager.HEADER_IF_MODIFIED);
		if (modifiedSince != -1) {
			modifiedSince -= modifiedSince % 1000;
		}
		String givenEtag = req.getHeader(ResourceManager.HEADER_IF_NONE);

		if (givenEtag == null) {
			if (modifiedSince > ResourceManager.servletContainerStartTime) {
				return true;
			}

			return false;
		}

		if (modifiedSince == -1) {
			if (!ResourceManager.etag.equals(givenEtag)) {
				return true;
			}

			return false;
		}

		if (ResourceManager.etag.equals(givenEtag) && (modifiedSince <= ResourceManager.servletContainerStartTime)) {
			return true;
		}

		return false;
	}

	// Clean up resources
	public void destroy() {
	}
}

/**
 * <pre>
 *   
 *         1) 什么是”Last-Modified”? 
 * 
 *         在浏览器第一次请求某一个URL时，服务器端的返回状态会是200，内容是你请求的资源，同时有一个Last-Modified的属性标记此文件在服务期端最后被修改的时间，格式类似这样： 
 * 
 *         Last-Modified: Fri, 12 May 2006 18:53:33 GMT 
 * 
 *         客户端第二次请求此URL时，根据 HTTP 协议的规定，浏览器会向服务器传送 If-Modified-Since 报头，询问该时间之后文件是否有被修改过： 
 * 
 *         If-Modified-Since: Fri, 12 May 2006 18:53:33 GMT 
 * 
 *         如果服务器端的资源没有变化，则自动返回 HTTP 304 （Not Changed.）状态码，内容为空，这样就节省了传输数据量。当服务器端代码发生改变或者重启服务器时，则重新发出资源，返回和第一次请求时类似。从而保证不向客户端重复发出资源，也保证当服务器有变化时，客户端能够得到最新的资源。 
 * 
 *         2) 什么是”Etag”? 
 * 
 *         HTTP 协议规格说明定义ETag (Entity Tags) 为“被请求变量的实体值” ,用来判断请求的文件是否被修改。 另一种说法是，ETag是一个可以与Web资源关联的记号（token）。典型的Web资源可以一个Web页，但也可能是JSON或XML文档。服务器单独负责判断记号是什么及其含义，并在HTTP响应头中将其传送到客户端，以下是服务器端返回的格式： 
 * 
 *         ETag: &quot;50b1c1d4f775c61:df3&quot; 
 * 
 *         客户端的查询更新格式是这样的： 
 * 
 *         If-None-Match: W/&quot;50b1c1d4f775c61:df3&quot; 
 * 
 *         如果ETag没改变，则返回状态304然后不返回，这也和Last-Modified一样。本人测试Etag主要在断点下载时比较有用。
 *         
 *       Last-Modified和Etags如何帮助提高性能?
 *         聪明的开发者会把Last-Modified 和ETags请求的http报头一起使用，这样可利用客户端（例如浏览器）的缓存。因为服务器首先产生 Last-Modified/Etag标记，服务器可在稍后使用它来判断页面是否已经被修改。本质上，客户端通过将该记号传回服务器要求服务器验证其（客户端）缓存。 
 *         过程如下:
 *                 1. 客户端请求一个页面（A）。 
 *                 2. 服务器返回页面A，并在给A加上一个Last-Modified/ETag。 
 *                 3. 客户端展现该页面，并将页面连同Last-Modified/ETag一起缓存。 
 *                 4. 客户再次请求页面A，并将上次请求时服务器返回的Last-Modified/ETag一起传递给服务器。 
 *                 5. 服务器检查该Last-Modified或ETag，并判断出该页面自上次客户端请求之后还未被修改，直接返回响应304和一个空的响应体。
 *                 
 *                 
 *                 
 *                 我们都知道，HTTP/1.1中有一个Etag，用来判断请求的文件是否被修改。
 * 为什么要使用Etag呢？Etag主要为了解决Last-Modified无法解决的一些问题
 * 1、一些文件也许会周期性的更改，但是他的内容并不改变(仅仅改变的修改时间)，这个时候我们并不希望客户端认为这个文件被修改了，而重新GET;
 * 2、某些文件修改非常频繁，比如在秒以下的时间内进行修改，(比方说1s内修改了N次)，If-Modified-Since能检查到的粒度是s级的，这种修改无法判断(或者说UNIX记录MTIME只能精确到秒)
 * 3、某些服务器不能精确的得到文件的最后修改时间；
 * 
 * 为此，HTTP/1.1引入了Etag(Entity Tags).Etag仅仅是一个和文件相关的标记，可以是一个版本标记,比如说v1.0.0或者说&quot;2e681a-6-5d044840&quot;这么一串看起来很神秘的编码。但是HTTP/1.1 标准并没有规定Etag的内容是什么或者说要怎么实现，唯一规定的是Etag需要放在&quot;&quot;内。
 * 
 * Etag由服务器端生成，客户端通过If-Match或者说If-None-Match这个条件判断请求来验证资源是否修改。我们常见的是使用If-None-Match.请求一个文件的流程可能如下：
 * ====第一次请求===
 * 1.客户端发起HTTP GET请求一个文件；
 * 2.服务器处理请求，返回文件内容和一堆Header，当然包括Etag(例如&quot;2e681a-6-5d044840&quot;)(假设服务器支持Etag生成和已经开启了Etag). 状态码200
 * 
 * ====第二次请求===
 * 1.客户端发起HTTP GET请求一个文件，注意这个时候客户端同时发送一个If-None-Match头，这个头的内容就是我们第一次请求时服务器返回的Etag：2e681a-6-5d044840
 * 2.服务器判断发送过来的Etag和计算出来的Etag匹配，因此If-None-Match为False，不返回200，返回304，客户端继续使用本地缓存；
 * 
 * 流程很简单，问题是，如果服务器又设置了Cache-Control:max-age和Expires呢，怎么办？
 * 答案是同时使用，也就是说在完全匹配If-Modified-Since和If-None-Match即检查完修改时间和Etag之后，服务器才能返回304.(不要陷入到底使用谁的问题怪圈)
 * 
 * 我们来看Apache中的Etag实现。
 * 1.Apache首先判断是不是弱Etag，这个留在下面讲。如果不是，进入第二种情况：
 * 
 * 强Etag根据配置文件中的配置来设置Etag值，默认的Apache的FileEtag设置为：
 * FileEtag INode Mtime Size
 * 也就是根据这三个属性来生成Etag值，他们之间通过一些算法来实现，并输出成hex的格式，相邻属性之间用-分隔，比如：
 * Etag &quot;2e681a-6-5d044840&quot;
 * 这里面的三个段，分别代表了INode，MTime，Size根据算法算出的值的Hex格式，(如果你在这里看到了非Hex里面的字符(也就是0-f)，那你可能看见神了:))
 * 
 * 当然，我们可以改变Apache的FileEtag设置，比如设置成FileEtag Size,那么得到的Etag可能为：
 * Etag &quot;6&quot;
 * 总之，设置了几个段，Etag值就有几个段。(不要误以为Etag就是固定的3段式)
 * 
 * 说明
 * 这里说的都是Apache 2.2里面的Etag实现，因为HTTP/1.1并没有规定Etag必须是什么样的实现或者格式，因此，你也可以修改或者完全编写自己的算法得到 Etag，比如 &quot;2e681a65d044840&quot;，客户端会记住并缓存下这个Etag(Windows里面保存在哪里，我还没找到:(), 下次访问的时候直接拿这个值去和服务器生成的Etag对比。
 * 
 * 注意
 * 不管怎么样的算法，在服务器端都要进行计算，计算就有开销，会带来性能损失。因此为了榨干这一点点性能，不少网站完全把Etag禁用了(比如Yahoo!)，这其实不符合HTTP/1.1的规定，因为HTTP/1.1总是鼓励服务器尽可能的开启Etag。
 * 
 * 弱校验(弱Etag)
 * 重新考虑前面提到的3个问题：
 * 问题1、一些文件也许会周期性的更改，但是他的内容并不改变(仅仅改变的修改时间)，这个时候我们并不希望客户端认为这个文件被修改了，而重新GET;
 * 
 * 解决办法：如果使用强Etag，每次得会要求重新GET页面，如果使用Etag，比方说设置成FileEtag Size等，就可以忽略MTime造成的Last-Modified时间修改从而影响了If-Modified-Since(IMS)这个校验了。这点和弱Etag无关。
 * 
 * 问题2、某些文件修改非常频繁，比如在秒以下的时间内进行修改，(比方说1s内修改了N次)，If-Modified-Since能检查到的粒度是s级的，这种修改无法判断(或者说UNIX记录MTIME只能精确到秒)
 * 
 * 解决办法：如果是这种情况，Apache会自动判断请求时间和修改时间之间的差值，如果小于1s，Apache会认为这个文件在这1秒内可能会再次被修改，因此生成一个弱Etag(Weak Etag),这个Etag仅仅基于MTime来生成，因此MTime只能精确到s，所以1s内生成的Etag总是一样，这样就避免了使用强Etag造成的 1s内频繁的刷新Cache的情况。(貌似不用Etag，仅仅使用Last-Modified就可以解决，但是这针对的仅仅是修改超级频繁的情况，很多文件可能同时也使用强Etag验证)。弱Etag以W/开始，比如:W/&quot;2e681a&quot;
 * 
 * 问题3、某些服务器不能精确的得到文件的最后修改时间；
 * 
 * 解决办法：生成Etag，因为Etag可以综合Inode，MTime和Size，可以避免这个问题
 * </pre>
 * 
 * 
 */
